package city.spring.modules.work.service;

import city.spring.modules.work.entity.WorkScheduleEntity;
import city.spring.modules.work.vo.WorkScheduleVO;
import com.baomidou.mybatisplus.extension.service.IService;

import java.time.LocalDate;
import java.util.List;

/**
 * Service：上班计划表（排班结果主体记录）
 *
 * @author 侯坤林
 * @date 2020-06-04 16:43:43
 */
public interface WorkScheduleService extends IService<WorkScheduleEntity> {
    String CACHE_NAME = "work_schedule";

    /**
     * 业务处理：保存一个 <strong>上班计划表（排班结果主体记录）</strong>
     *
     * @param entity 上班计划表（排班结果主体记录）
     */
    void saveWorkSchedule(WorkScheduleEntity entity);

    /**
     * 业务处理：修改一个 <strong>上班计划表（排班结果主体记录）</strong>
     *
     * @param entity 上班计划表（排班结果主体记录）
     */
    void updateWorkSchedule(WorkScheduleEntity entity);

    /**
     * 业务处理：删除一个 <strong>上班计划表（排班结果主体记录）</strong>
     *
     * @param primaryKey 主键ID
     */
    void deleteWorkSchedule(String primaryKey);

    /**
     * 业务处理：删除多个 <strong>上班计划表（排班结果主体记录）</strong>
     *
     * @param primaryKeys 主键ID列表
     */
    void deleteWorkSchedule(List<String> primaryKeys);

    /**
     * 获取一个详细的排班表信息
     *
     * @param primaryKey 主键
     * @return 排班表详细信息对象
     */
    WorkScheduleVO getWorkSchedule(String primaryKey);

    /**
     * 获得这一天的所有排班表结果主体数据
     *
     * @param date    日期
     * @param enabled 是否启用，null则忽略
     * @return 排班表主体数据对象列表 day work schedules
     */
    List<WorkScheduleEntity> getDayWorkSchedules(LocalDate date, Boolean enabled);

    /**
     * 加载指定用户的某个日期可用值班信息列表
     *
     * @param userId  用户ID
     * @param date    查询日期
     * @param history 是否加载全部（加载历史值班）
     * @return 用户的值班列表
     */
    List<WorkScheduleVO> getUserWorkSchedule(String userId, LocalDate date, boolean history);
}